<!DOCTYPE html>
<html lang="en">
  <head>
    <title>CType Class Reference</title>
    <link rel="stylesheet" type="text/css" href="../../css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="../../css/highlight.css" />
    <meta charset="utf-8">
    <script src="../../js/jquery.min.js" defer></script>
    <script src="../../js/jazzy.js" defer></script>
    
    <script src="../../js/lunr.min.js" defer></script>
    <script src="../../js/typeahead.jquery.js" defer></script>
    <script src="../../js/jazzy.search.js" defer></script>
  </head>
  <body>

    <a name="//apple_ref/swift/Class/CType" class="dashAnchor"></a>

    <a title="CType Class Reference"></a>

    <header class="header">
      <p class="header-col header-col--primary">
        <a class="header-link" href="../../index.html">
          gir2swift 6.0.0 Docs
        </a>
         (98% documented)
      </p>
    
      <p class="header-col--secondary">
        <form role="search" action="../../search.json">
          <input type="text" placeholder="Search documentation" data-typeahead>
        </form>
      </p>
    
        <p class="header-col header-col--secondary">
          <a class="header-link" href="https://github.com/rhx/gir2swift">
            <img class="header-icon" src="../../img/gh.png"/>
            View on GitHub
          </a>
        </p>
    
        <p class="header-col header-col--secondary">
          <a class="header-link" href="dash-feed://http%3A%2F%2Frhx%2Egithub%2Eio%2Fgir2swift%2Fdocsets%2Fgir2swift%2Exml">
            <img class="header-icon" src="../../img/dash.png"/>
            Install in Dash
          </a>
        </p>
    </header>

    <p class="breadcrumbs">
      <a class="breadcrumb" href="../../index.html">gir2swift Reference</a>
      <img class="carat" src="../../img/carat.png" />
      CType Class Reference
    </p>

    <div class="content-wrapper">
      <nav class="navigation">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../../Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Classes/GIR.html">GIR</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Classes/GIR/Thing.html">– Thing</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Classes/GIR/Datatype.html">– Datatype</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Classes/GIR/CType.html">– CType</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Classes/GIR/Alias.html">– Alias</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Classes/GIR/Constant.html">– Constant</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Classes/GIR/Enumeration.html">– Enumeration</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Classes/GIR/Bitfield.html">– Bitfield</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Classes/GIR/Record.html">– Record</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Classes/GIR/Class.html">– Class</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Classes/GIR/Interface.html">– Interface</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Classes/GIR/Method.html">– Method</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Classes/GIR/Function.html">– Function</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Classes/GIR/Callback.html">– Callback</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Classes/GIR/Signal.html">– Signal</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Classes/GIR/Property.html">– Property</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Classes/GIR/Argument.html">– Argument</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../../Extensions.html">Extensions</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Extensions/BidirectionalCollection.html">BidirectionalCollection</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Extensions/Collection.html">Collection</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Extensions/Sequence.html">Sequence</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Extensions/String.html">String</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Extensions/String.html">String</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Extensions/String/UTF8View.html">– UTF8View</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Extensions/XMLElement.html">XMLElement</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../../Functions.html">Functions</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift1loiySbAA3GIRC5ThingC_AFtF">&lt;(_:_:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift2eeoiySbAA3GIRC5ThingC_AFtF">==(_:_:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift8callCode__3ptrSSAA3GIRC6MethodCcSS_AE6RecordCSgSStF">callCode(_:_:ptr:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift10callSetter__3ptrSSAA3GIRC6MethodCcSS_AE6RecordCSgSStF">callSetter(_:_:ptr:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift7codeFor8argumentSSAA3GIRC8ArgumentC_tF">codeFor(argument:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift7codeFor8argument6prefixSSAA3GIRC8ArgumentC_SStF">codeFor(argument:prefix:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift11commentCode_11indentationSSAA3GIRC5ThingC_SStF">commentCode(_:indentation:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift20computedPropertyCode_6record17publicDesignation3ptrSSAA16GetterSetterPairVcSS_AA3GIRC6RecordCS2StF">computedPropertyCode(_:record:publicDesignation:ptr:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift16constructorParam_6prefixSSAA3GIRC6MethodC_SSSgtF">constructorParam(_:prefix:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift17constructorPrefixySSSgAA3GIRC6MethodCF">constructorPrefix(_:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift26convenienceConstructorCode_11indentation0B017publicDesignation7factory11convertNameSSAA3GIRC6MethodCcAI6RecordCcSS_S3SSbS2SctF">convenienceConstructorCode(_:indentation:convenience:publicDesignation:factory:convertName:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift31convertSetterArgumentToSwiftFor_3ptrSSAA3GIRC0D0CcAE6RecordCSg_SStF">convertSetterArgumentToSwiftFor(_:ptr:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift14deprecatedCode_11indentationSSSgAA3GIRC5ThingC_SStF">deprecatedCode(_:indentation:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift12functionCode_11indentation18initialIndentationSSAA3GIRC8FunctionC_S2StF">functionCode(_:indentation:initialIndentation:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift7get_optySJ_SSSgtSgSSF">get_opt(_:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift17getterSetterPairs3forSayAA06GetterC4PairVGSayAA3GIRC6MethodCG_tF">getterSetterPairs(for:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift15gtkDoc2SwiftDoc_10linePrefixS2S_SStF">gtkDoc2SwiftDoc(_:linePrefix:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift10methodCode_18initialIndentation6record17publicDesignation11convertName3ptrSSAA3GIRC6MethodCcSS_SSSgAI6RecordCSgS3ScSStF">methodCode(_:initialIndentation:record:publicDesignation:convertName:ptr:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift15recordClassCode_6parent11indentation3ptrSSAA3GIRC6RecordC_S3StF">recordClassCode(_:parent:indentation:ptr:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift18recordProtocolCode_6parent11indentation3ptrSSAA3GIRC6RecordC_S3StF">recordProtocolCode(_:parent:indentation:ptr:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift27recordProtocolExtensionCode__11indentation3ptrSSSayAA3GIRC8FunctionCG_AF6RecordCS2StF">recordProtocolExtensionCode(_:_:indentation:ptr:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift16recordStructCode_11indentation3ptrSSAA3GIRC6RecordC_S2StF">recordStructCode(_:indentation:ptr:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift10returnCode__3ptrSSAA3GIRC6MethodCcSS_SS8typeName_AE6RecordC6recordSb13isConstructorSb0K11ConveniencetSgSStF">returnCode(_:_:ptr:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift21returnDeclarationCodeySSAA3GIRC6MethodCcSS8typeName_AD6RecordC6recordSb13isConstructortSgF">returnDeclarationCode(_:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift14returnTypeCodeySSSgAA3GIRC6MethodCcSS8typeName_AE6RecordC6recordSb13isConstructortSgF">returnTypeCode(_:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift14signalNameCode11indentation07convertC0SSAA3GIRC5CTypeCcSS_S2SctF">signalNameCode(indentation:convertName:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift14signalNameCode11indentation8prefixes07convertC0SSAA3GIRC5CTypeCcSS_SS_SStS2SctF">signalNameCode(indentation:prefixes:convertName:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift22swiftCallbackAliasCode8callbackSSAA3GIRC0C0C_tF">swiftCallbackAliasCode(callback:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift9swiftCodeySSAA3GIRC11EnumerationCF">swiftCode(_:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift9swiftCodeySSAA3GIRC6RecordCcSScSayAD8FunctionCGF">swiftCode(_:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift9swiftCodeySSAA3GIRC8FunctionCF">swiftCode(_:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift9swiftCode__11indentationSSAA3GIRC5ThingC_S2StF">swiftCode(_:_:indentation:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift9swiftCode5aliasSSAA3GIRC5AliasC_tF">swiftCode(alias:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift9swiftCode8constantSSAA3GIRC8ConstantC_tF">swiftCode(constant:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift7toSwift_3ptrSSAA3GIRC8ArgumentC_SStF">toSwift(_:ptr:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift9typeAliasySSAA3GIRC11EnumerationCF">typeAlias(_:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift9valueCodeySSAA3GIRC8ConstantCcSSF">valueCode(_:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift9with_mmap_10protection5flags7processySS_s5Int32VAGySRyxGXEtlF">with_mmap(_:protection:flags:process:)</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Functions.html#/s:12libgir2swift9with_mmap_10protection5flags7processySS_s5Int32VAGySv_SitXEtF">with_mmap(_:protection:flags:process:)</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="../../Structs.html">Structures</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="../../Structs.html#/s:12libgir2swift16GetterSetterPairV">GetterSetterPair</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">

        <section class="section">
          <div class="section-content">
            <h1>CType</h1>
              <div class="declaration">
                <div class="language">
                  <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">CType</span> <span class="p">:</span> <span class="kt"><a href="../../Classes/GIR/Datatype.html">Datatype</a></span></code></pre>

                </div>
              </div>
            <p>a type with an underlying C type entry</p>

          </div>
        </section>

        <section class="section">
          <div class="section-content">
            <div class="task-group">
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12libgir2swift3GIRC5CTypeC4kindSSvp"></a>
                    <a name="//apple_ref/swift/Property/kind" class="dashAnchor"></a>
                    <a class="token" href="#/s:12libgir2swift3GIRC5CTypeC4kindSSvp">kind</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>String representation of the <code>CType</code> thing</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">override</span> <span class="k">var</span> <span class="nv">kind</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/rhx/gir2swift/tree/master/Sources/libgir2swift/gir.swift#L340">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12libgir2swift3GIRC5CTypeC5ctypeSSvp"></a>
                    <a name="//apple_ref/swift/Property/ctype" class="dashAnchor"></a>
                    <a class="token" href="#/s:12libgir2swift3GIRC5CTypeC5ctypeSSvp">ctype</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>underlying C type</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">ctype</span><span class="p">:</span> <span class="kt">String</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/rhx/gir2swift/tree/master/Sources/libgir2swift/gir.swift#L342">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12libgir2swift3GIRC5CTypeC14containedTypesSayAEGvp"></a>
                    <a name="//apple_ref/swift/Property/containedTypes" class="dashAnchor"></a>
                    <a class="token" href="#/s:12libgir2swift3GIRC5CTypeC14containedTypesSayAEGvp">containedTypes</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>list of contained types</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">containedTypes</span><span class="p">:</span> <span class="p">[</span><span class="kt">CType</span><span class="p">]</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/rhx/gir2swift/tree/master/Sources/libgir2swift/gir.swift#L344">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12libgir2swift3GIRC5CTypeC8nullableSbvp"></a>
                    <a name="//apple_ref/swift/Property/nullable" class="dashAnchor"></a>
                    <a class="token" href="#/s:12libgir2swift3GIRC5CTypeC8nullableSbvp">nullable</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p><code>true</code> if this is an optional</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">nullable</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/rhx/gir2swift/tree/master/Sources/libgir2swift/gir.swift#L346">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12libgir2swift3GIRC5CTypeC5scopeSSSgvp"></a>
                    <a name="//apple_ref/swift/Property/scope" class="dashAnchor"></a>
                    <a class="token" href="#/s:12libgir2swift3GIRC5CTypeC5scopeSSSgvp">scope</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>reference scope</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">scope</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/rhx/gir2swift/tree/master/Sources/libgir2swift/gir.swift#L348">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12libgir2swift3GIRC5CTypeC4name4type5ctype7comment14introspectable10deprecated10isNullable8contains5scopeAESS_S3SSbSSSgSbSayAEGAOtcfc"></a>
                    <a name="//apple_ref/swift/Method/init(name:type:ctype:comment:introspectable:deprecated:isNullable:contains:scope:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:12libgir2swift3GIRC5CTypeC4name4type5ctype7comment14introspectable10deprecated10isNullable8contains5scopeAESS_S3SSbSSSgSbSayAEGAOtcfc">init(name:type:ctype:comment:introspectable:deprecated:isNullable:contains:scope:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Designated initialiser</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">type</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">ctype</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">comment</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">introspectable</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span> <span class="nv">deprecated</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">isNullable</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span> <span class="nv">contains</span><span class="p">:</span> <span class="p">[</span><span class="kt">CType</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span> <span class="nv">scope</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>name</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The name of the <code><a href="../../Classes/GIR/Datatype.html">Datatype</a></code> to initialise</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>type</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>C typedef name of the data type</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>ctype</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>underlying C type</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>comment</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Documentation text for the data type</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>introspectable</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Set to <code>true</code> if introspectable</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>deprecated</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Documentation on deprecation status if non-<code>nil</code></p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>isNullable</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Set to <code>true</code> if this is a nullable type</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>contains</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Array of C types contained within this type</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>scope</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The scope this type belongs in</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/rhx/gir2swift/tree/master/Sources/libgir2swift/gir.swift#L361-L367">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12libgir2swift3GIRC5CTypeC4node7atIndex8nameAttr04typeH005cTypeH008nullableH005scopeH0AE11SwiftLibXML10XMLElementV_SiS3SSgS2Stcfc"></a>
                    <a name="//apple_ref/swift/Method/init(node:atIndex:nameAttr:typeAttr:cTypeAttr:nullableAttr:scopeAttr:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:12libgir2swift3GIRC5CTypeC4node7atIndex8nameAttr04typeH005cTypeH008nullableH005scopeH0AE11SwiftLibXML10XMLElementV_SiS3SSgS2Stcfc">init(node:atIndex:nameAttr:typeAttr:cTypeAttr:nullableAttr:scopeAttr:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>XML Element initialser</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">node</span><span class="p">:</span> <span class="kt">XMLElement</span><span class="p">,</span> <span class="n">atIndex</span> <span class="nv">i</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">nameAttr</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"name"</span><span class="p">,</span> <span class="nv">typeAttr</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"type"</span><span class="p">,</span> <span class="nv">cTypeAttr</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">nullableAttr</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"nullable"</span><span class="p">,</span> <span class="nv">scopeAttr</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"scope"</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>node</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p><code>XMLElement</code> to construct this C type from</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>i</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Index within the siblings of the <code>node</code></p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>nameAttr</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Key for the attribute to extract the <code>name</code> property from</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>typeAttr</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Key for the attribute to extract the <code>type</code> property from</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>cTypeAttr</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Key for the attribute to extract the  C type property from</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>nullableAttr</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Key for the attribute to extract the  nullability status from</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>scopeAttr</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Key for the attribute to extract the  scope string from</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/rhx/gir2swift/tree/master/Sources/libgir2swift/gir.swift#L378-L398">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12libgir2swift3GIRC5CTypeC14fromChildrenOf7atIndex8nameAttr04typeJ008nullableJ005scopeJ0AE11SwiftLibXML10XMLElementV_SiS4Stcfc"></a>
                    <a name="//apple_ref/swift/Method/init(fromChildrenOf:atIndex:nameAttr:typeAttr:nullableAttr:scopeAttr:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:12libgir2swift3GIRC5CTypeC14fromChildrenOf7atIndex8nameAttr04typeJ008nullableJ005scopeJ0AE11SwiftLibXML10XMLElementV_SiS4Stcfc">init(fromChildrenOf:atIndex:nameAttr:typeAttr:nullableAttr:scopeAttr:)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Factory method to construct a C Type from XML with types taken from children</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="n">fromChildrenOf</span> <span class="nv">node</span><span class="p">:</span> <span class="kt">XMLElement</span><span class="p">,</span> <span class="n">atIndex</span> <span class="nv">i</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">nameAttr</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"name"</span><span class="p">,</span> <span class="nv">typeAttr</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"type"</span><span class="p">,</span> <span class="nv">nullableAttr</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"nullable"</span><span class="p">,</span> <span class="nv">scopeAttr</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"scope"</span><span class="p">)</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>node</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p><code>XMLElement</code> whose descendants to construct this C type from</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>i</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Index within the siblings of the <code>node</code></p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>nameAttr</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Key for the attribute to extract the <code>name</code> property from</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>typeAttr</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Key for the attribute to extract the <code>type</code> property from</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>nullableAttr</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Key for the attribute to extract the  nullability status from</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>scopeAttr</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Key for the attribute to extract the  scope string from</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/rhx/gir2swift/tree/master/Sources/libgir2swift/gir.swift#L408-L423">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12libgir2swift3GIRC5CTypeC6isVoidSbvp"></a>
                    <a name="//apple_ref/swift/Property/isVoid" class="dashAnchor"></a>
                    <a class="token" href="#/s:12libgir2swift3GIRC5CTypeC6isVoidSbvp">isVoid</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>return whether the give C type is void</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="k">override</span> <span class="kd">public</span> <span class="k">var</span> <span class="nv">isVoid</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/rhx/gir2swift/tree/master/Sources/libgir2swift/gir.swift#L426-L429">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:12libgir2swift3GIRC5CTypeC7isArraySbvp"></a>
                    <a name="//apple_ref/swift/Property/isArray" class="dashAnchor"></a>
                    <a class="token" href="#/s:12libgir2swift3GIRC5CTypeC7isArraySbvp">isArray</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>return whether the type is an array</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isArray</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>

                        </div>
                      </div>
                      <div class="slightly-smaller">
                        <a href="https://github.com/rhx/gir2swift/tree/master/Sources/libgir2swift/gir.swift#L432">Show on GitHub</a>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </div>
        </section>

      </article>
    </div>
    <section class="footer">
      <p>&copy; 2019 <a class="link" href="https://www.ict.griffith.edu.au/~rhexel/" target="_blank" rel="external">Ren&eacute;&nbsp;Hexel</a>. All rights reserved. (Last updated: 2019-12-12)</p>
      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.11.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
    </section>
  </body>
</div>
</html>
